Embed recovery. Fixes MER#1987 #27

Thaodan · 2018-11-19T01:23:20Z

Some devices like Sonys X series have no recovery partition on these devices the recovery needs to be inside the regular initramfs.

To do so we check if skip_initramfs hasn't been passed (read line 56) and then start the recovery.

Background:
Bootloaders for Android phones pass skip_init_ramfs when the system should be booted normally and don't pass it when the key combination for recovery mode was used.
We piggy back on this behavior by using the kernel commandline option is mostly the samen way except that we always use a init-ramfs.

sledges

Many thanks for your contribution!

I haven't checked the changes in .sh for now

sledges · 2018-11-19T15:40:08Z

droid-hal-device-img-boot.inc

@@ -73,6 +75,12 @@ BuildRequires:  yamui
 BuildRequires:  openssh-clients
 BuildRequires:  openssh-server

+%if 0%{?embed_recovery:1}
+BuildRequires: shpp


Your contribution of shpp is appreciated, but I'm afraid it cannot be justified in the context of HW adaptation recovery, as we are trying to keep dependencies to a minimum. In this particular use-case a sed command should be sufficient.

sledges · 2018-11-19T15:45:18Z

droid-hal-device-img-boot.inc

+%if 0%{?embed_recovery:1}
+BuildRequires: shpp
+%else
+%define embed_recovery 0


This renders some parts of the code unreachable, because defining something in .spec (even if equal to 0), counts as defined.
See here: https://backreference.org/2011/09/17/some-tips-on-rpm-conditional-macros/
and here: https://github.com/mer-hybris/droid-hal-device/blob/5fd1782c7f7b898fd66469d6cd43890c82219730/droid-hal-%40DEVICE%40.spec.template#L14

sledges · 2018-11-19T15:46:01Z

droid-hal-device-img-boot.inc

@@ -98,6 +106,7 @@ Requires: oneshot
 %description
 %{summary}

+%if 0%{!?embed_recovery:1}


As mentioned above, this %if never evaluates to true, because embed_recovery is now always defined (either to 1, or to 0). This also applies to all similar statements against embed_recovery below

sledges · 2018-11-19T15:46:35Z

droid-hal-device-img-boot.inc

 popd
-%{mkbootimg_cmd} hybris-boot.img
-
+%{mkbootimg_cmd} hybris-boot.img 


extra space at the end of the line (makes the diff a bit unclear)

sledges · 2018-11-19T15:48:15Z

droid-hal-device-img-boot.inc

@@ -17,6 +17,8 @@
 # battery_capacity_file:      Path to read current battery charge from.
 # battery_capacity_threshold: Battery threshold for factory reset [0, 100].
 #                             Default 0 (no threshold).
+# embed_recovery: in case the recovery needs to embeded inside


nitpicking a typo: "needs to be embedded"

Thaodan · 2018-11-19T16:06:02Z

How can I default to an alternative value like in shell Scripts with ${too:-bar} ? About the dependencies , how would you do this with just sed? I'm not sure how to do this in a clean way.

sledges · 2018-11-20T17:10:22Z

How can I default to an alternative value like in shell Scripts with ${too:-bar} ?

%{?foo}%{!?foo:bar}, e.g. %{?embed_recovery}%{!?embed_recovery:0}

About the dependencies , how would you do this with just sed? I'm not sure how to do this in a clean way.

sed "s/@EMBED_RECOVERY@/%{?embed_recovery}%{!?embed_recovery:0}/g" -i %{_local_initrd_dir}/jolla-init

sledges · 2018-11-29T14:24:59Z

sed "s/@EMBED_RECOVERY@/%{?embed_recovery}%{!?embed_recovery:0}/g" -i %{_local_initrd_dir}/jolla-init

Below link is the complete rewrite without sed, I have not fully tested on a running device yet, as I have some doubts about this line: sledges@58ab8a4#diff-ae5e5322c8e93e423e4ef2ac5e20cd84R101
Will test when I find time ASAP, probably early next week.

Apologies for coming back on this only now, but github does not send emails about updated PR. We're lucky I was checking my timesheed as it's the end of the month, and found your PR again:)

Thaodan · 2018-11-29T23:08:03Z

@sledges No problem. I fixed that line that you mean in mksfosinitrd and cleaned that feature a bit up.
About the actual init script to you want the embed recovery code to be present when embed recovery is not used or not present when its not used (shpp solution)?

In case the recovery needs to embeded inside the regular initramfs.

krnlyng · 2019-06-22T17:41:56Z

droid-hal-device-img-boot.inc

@@ -202,11 +212,13 @@ touch %{buildroot}/lib/modules/%{kernelver}/{modules.order,modules.builtin}
 %defattr(-,root,root,-)
 /boot/hybris-boot.img
 %defattr(644,root,root,-)
-/lib/modules/%{kernelver}
+/Li/modules/%{kernelver}


Is this a typo?

Thaodan · 2019-06-22T19:30:48Z

Yes fixed.

Olf0 · 2021-08-30T01:29:29Z

This was looking well on its way and close to be ready for merging, after the many fixes and improvements above.
@sledges & @Thaodan, is there a specific reason, why this has been stalling for more than 2 years?

Olf0 · 2021-09-05T23:43:44Z

The reason why iI am asking, is that

The "Changes requested" displayed below are the ones @sledges requested on 19 Nov 2018: AFAICS these have been addressed. Hence @sledges' open ToDos might be to perform his "I haven't checked the changes in .sh for now" to finish his review and ultimately close the open review process.
@Thaodan's last comment is "Yes fixed." on 22 Jun 2019, hence I assume he sees no open issues with this MR for more than two years now.
Because this MR has been stalled for more than two years, meanwhile merges now result in merge conflicts and created the need to re-base. This will only become worse, if the stalling continues.
The Xperia 10 II is the first device officially supported by Jolla, which needs an "embedded recovery". As its support was announced and deployed in early 2021, resolving this issue (MER#1987) is crucial in order to cease offering the clumsy, current official advice to stubbornly flash the recovery image, use it and then re-flash the boot image.

sledges · 2021-09-06T11:22:19Z

This was looking well on its way and close to be ready for merging, after the many fixes and improvements above.
@sledges & @Thaodan, is there a specific reason, why this has been stalling for more than 2 years?

The reason is that such change needs to be tested on all Jolla's supported devices to avoid regressions, and in case such risk is minimal and/or this functionality is not enabled in a given kernel, the work of updating submodule for each device is still required.

Since we had had a workaround for recovery, this PR was not on a critical path and thus turned into technical debt, due to other priorities.
It has certainly become more actual with releasing Xperia 10 II, and we will adjust prioritisation accordingly as possible. For now please use the workaround [1], which is, agreed, more involving than other Xperias, nevertheless recovery mode is (and should) not be a frequently used feature.

[1] https://jolla.zendesk.com/hc/en-us/articles/360021620740

Olf0 · 2022-05-28T17:48:45Z

[…] this PR […] turned into technical debt, due to other priorities. It has certainly become more actual with releasing Xperia 10 II, and we will adjust prioritisation accordingly as possible.

… and even more so by releasing SailfishOS for the Xperia 10 III recently.

Thaodan · 2022-08-18T07:53:38Z

Summary of what has to be done to use this PR.

Rebase the PR (cc me :) )
Update the droid-hal-img-boot submodule to use this patch/branch, (%define embed_recovery)
Make sure that Ignore skip_initramfs is still passed but doesn't do anything on your devices kernel. For the Xperia XA2 this PR can be used:
Revert Ignore skip_initramfs for now but keep kernel option MER#1988 android_kernel_sony_msm#26
This commit contains the required change:
mer-hybris/android_kernel_sony_msm@c73ed25

Both droid-hal and droid-hal-img-boot have to be build after applying the changes mentioned above, after doing so flashing hybris_boot.img is enough to test if the PR works.

Thaodan · 2024-05-31T22:08:16Z

This PR is obsolete for devices using Android 12 and up.
It was never required for devices using a dedicated recovery partition (refer to the graph above for devices starting with Android 13):
https://source.android.com/docs/core/architecture/partitions/generic-boot#figure-2

Thaodan mentioned this pull request Nov 19, 2018

[recovery] Support embed recovery. Fixes MER#1988 mer-hybris/droid-hal-img-boot-sony-nile#5

Open

Thaodan force-pushed the embed_recovery branch from 2d357e6 to 347fe8d Compare November 19, 2018 09:53

sledges suggested changes Nov 19, 2018

View reviewed changes

Thaodan force-pushed the embed_recovery branch from 347fe8d to 976a6aa Compare November 22, 2018 14:18

Thaodan force-pushed the embed_recovery branch 2 times, most recently from a4339d3 to 9ecb179 Compare November 29, 2018 23:01

Thaodan force-pushed the embed_recovery branch from 9ecb179 to 117c4b4 Compare April 13, 2019 02:45

Thaodan force-pushed the embed_recovery branch from 117c4b4 to dae4331 Compare June 21, 2019 10:39

[recovery] supported embedding the recovery inside regular initramfs

67d0be8

In case the recovery needs to embeded inside the regular initramfs.

Thaodan force-pushed the embed_recovery branch from dae4331 to 2b0a090 Compare June 21, 2019 10:41

krnlyng reviewed Jun 22, 2019

View reviewed changes

Thaodan added 3 commits June 22, 2019 21:25

[rpm] Disable recovery img when embed recovery is defined. MER#1987

217de25

[initrd] Use [ instead of test with workarounds

d688cdb

[initrd] Support adding recovery tools to regular initrd. MER#1987

bb8089b

Thaodan force-pushed the embed_recovery branch from 2b0a090 to bb8089b Compare June 22, 2019 19:25

Olf0 mentioned this pull request May 28, 2022

Embed recovery, see also MER#1987 #52

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Embed recovery. Fixes MER#1987 #27

Embed recovery. Fixes MER#1987 #27

Thaodan commented Nov 19, 2018 •

edited

Loading

sledges left a comment

sledges Nov 19, 2018

sledges Nov 19, 2018

sledges Nov 19, 2018

sledges Nov 19, 2018

sledges Nov 19, 2018

Thaodan commented Nov 19, 2018 via email

sledges commented Nov 20, 2018 •

edited

Loading

sledges commented Nov 29, 2018

Thaodan commented Nov 29, 2018

krnlyng Jun 22, 2019

Thaodan commented Jun 22, 2019 via email

Olf0 commented Aug 30, 2021 •

edited

Loading

Olf0 commented Sep 5, 2021 •

edited

Loading

sledges commented Sep 6, 2021

Olf0 commented May 28, 2022 •

edited

Loading

Thaodan commented Aug 18, 2022 •

edited

Loading

Thaodan commented May 31, 2024

Embed recovery. Fixes MER#1987 #27

Are you sure you want to change the base?

Embed recovery. Fixes MER#1987 #27

Conversation

Thaodan commented Nov 19, 2018 • edited Loading

sledges left a comment

Choose a reason for hiding this comment

sledges Nov 19, 2018

Choose a reason for hiding this comment

sledges Nov 19, 2018

Choose a reason for hiding this comment

sledges Nov 19, 2018

Choose a reason for hiding this comment

sledges Nov 19, 2018

Choose a reason for hiding this comment

sledges Nov 19, 2018

Choose a reason for hiding this comment

Thaodan commented Nov 19, 2018 via email

sledges commented Nov 20, 2018 • edited Loading

sledges commented Nov 29, 2018

Thaodan commented Nov 29, 2018

krnlyng Jun 22, 2019

Choose a reason for hiding this comment

Thaodan commented Jun 22, 2019 via email

Olf0 commented Aug 30, 2021 • edited Loading

Olf0 commented Sep 5, 2021 • edited Loading

sledges commented Sep 6, 2021

Olf0 commented May 28, 2022 • edited Loading

Thaodan commented Aug 18, 2022 • edited Loading

Thaodan commented May 31, 2024

Thaodan commented Nov 19, 2018 •

edited

Loading

sledges commented Nov 20, 2018 •

edited

Loading

Olf0 commented Aug 30, 2021 •

edited

Loading

Olf0 commented Sep 5, 2021 •

edited

Loading

Olf0 commented May 28, 2022 •

edited

Loading

Thaodan commented Aug 18, 2022 •

edited

Loading